Plastics Management API
V2 Release Notes
New V2 API
/connex/cvv.get
/connex/card.delete: No changes in the Request or Response from V1 to V2.
/connex/card.get
| V2 Request | V1 Request |
|---|---|
| NEW cvv, event Identifier |
SAME wrappedKey, cardExpirationDate, eventIdentifier |
| REMOVED includePrimaryMemberOnly, includeAccountDetails, plastic |
|
| V1 Response | REMOVED - 2 Data Sets |
|---|---|
| demographics | dateLastUsed, dateLastUpdated, dateLastMaintained, pinFailCount, limitGroup, canWithdraw, canDeposit, canInquire, paymentsTo, paymentsFrom, transfersTo, transfersFrom, canPurchase, thirdPartyPymt, pinOffsetIndicator, pinOffset, expirationDate, greetingName, mobileEnrollment, avsData, lastDemographicUpdated, cardStatus, prevCardStatus, lastCardStatusUpdated, activationStatus, activationMethod, activationTime, prevCardExpirationDate, prevCardActivationStatus, lastTimePinChanged, cardMediaType, serviceCode, cardProfile, autoIssueInd, cardAssociation, cardType, cardSubType, customerSince, vipInd, embossedBusiness, cardCategory, hasCardCompanionMini, hasCardCompanionMicro, hasCardCompanionMobile, contactPref, creditLimit, cashLimit, pwrOfAttrnyFlag, pwrOfAttrnyName, bankBranchNo, vruCntrCardAct, vruCntrPinChange, alrtEventNo, alrtEventDate, alrtEventLtd, schdBlockDate, severityLvl, travelInd, travelStartDate, travelEndDate |
| accounts | financialInstitutionId, accountNumber, accountType, accountQualifier, oarSelectType, accountDescription, canAccountWithdraw, canAccountDeposit, canAccountInquiry, paymentsToAccount, paymentsFromAccount, transferToAccount, transferFromAccount, canAccountPurchase, thirdPartyPayments, primaryIndicator, fundingIndicator, ledgerBalance, availableBalance, creditLineAmount, lastTransactionTimestamp, accountStatus, overdraftAmount, overdraftFinancialInstitutionID, overdraftAccountNumber, overdraftAccountType |
/connex/card-replacement
| V2 Request | V1 Request |
|---|---|
| NEW includeAccountDetails, bin, replacementCardDetails, flatCardInd, issuerStockCode, customImageId |
SAME pan, plastic, expirationDate, oldPanNumber, cardOrderFlag, cardOrderStatusFlag, photoId, oldPlasticNumber, cardReissueIndicator, imageId, cardStockCode, cardOrderType, oldCardStatus, oldCardActivationStatus |
| REMOVED plasticReplacementDetail |
Response
| V2 Response | V1 Response |
|---|---|
| NEW dateLastMaintained, dateLastUpdated, dateLastUsed, enterpriseCustomerId, pan, includeAccountDetails, plastic, bin, replacementCardDetails, flatCardInd, issuerStockCode, customImageId |
SAME returnCode, success, message, data, expirationDate, cardOrderFlag, cardOrderStatusFlag, cardOrderType, cardReissueIndicator, cardStockCode, photoId, imageId, oldPanNumber, oldPlasticNumber, oldCardActivationStatus, oldCardStatus |
| REMOVED plasticReplacementDetail |
/connex/card-reissuance
| V2 Request | V1 Request |
|---|---|
| NEW dateLastMaintained, dateLastUpdated, dateLastUsed, reissueDetails, flatCardInd, issuerStockCode, customImageId |
SAME pan, expirationDate, activationFlag, cardOrderFlag, cardOrderStatusFlag, addressType, photoId, cardReissueIndicator, memberNumber, imageId, embossedName, cardStockCode, cardOrderType |
| REMOVED plastic, plasticReissuanceDetail |
Response
| V2 Response | V1 Response |
|---|---|
| NEW dateLastMaintained, dateLastUpdated, dateLastUsed, reissueDetails, flatCardInd, issuerStockCode, customImageId |
SAME returnCode, success, message, data, memberNumber, activationFlag, expirationDate, addressType, embossedName, cardOrderFlag, cardOrderStatusFlag, cardOrderType, cardReissueIndicator, cardStockCode, photoId, imageId |
| REMOVED plasticReissuanceDetail |
/connex/card.get POST
| V2 Request POST | V1 Request POST |
|---|---|
| NEW bin, enterpriseCustomerId, addresses: {addressFormat, addressLine1, addressLine2, addressLine3, addressLine4, addressType, beginUsageDate, city, countryCode, endUsageDate, lastAddressUpdated, postalCode, stateProvince}; members: {cardOrdFlag, cardOrdStatDate, cardOrdStatFlag, cardOrdType, cardReplInd, cardStockCode, customImageId, dateLastIssued, dateOfBirth, dateOrigIssued, emailAddress1, emailAddress2, embossedName, firstName, flatCardInd, imageId, isPrimaryContact, issuerStockCode, languageInd, lastMemberUpdated, lastName, memberNum, middleInitial, militaryEndDate, militaryFlag, militaryStartDate, motherMaidenName, passcode, phones, firstCallInd, phoneNum, phoneType, photoId, prefix, socialSecurityNumber, suffix, trackNameMatch, userValidation;} (*same data set repeated for three (3) other members); optOutVauAbuFlag, prevCardActivationStatus, prevCardExpirationDate, previousCards, replacedByCards |
SAME pan, includeAccountDetails, pinFailCount, limitGroup, canWithdraw, canDeposit, canInquire, paymentsTo, paymentsFrom, transfersTo, transfersFrom, canPurchase, thirdPartyPymt, pinOffsetIndicator, pinOffset, expirationDate, greetingName, mobileEnrollment, avsData, lastDemographicUpdated, cardStatus, prevCardStatus, lastCardStatusUpdated, prevCardExpirationDate, prevCardActivationStatus, lastTimePinChanged, cardMediaType, serviceCode, cardProfile, autoIssueInd, cardAssociation, cardType, cardSubType, customerSince, vipInd, embossedBusiness, cardCategory, hasCardCompanionMini, hasCardCompanionMicro, hasCardCompanionMobile, contactPref, creditLimit, cashLimit, pwrOfAttrnyFlag, pwrOfAttrnyName, bankBranchNo, vruCntrCardAct, vruCntrPinChange, alrtEventNo, alrtEventDate, alrtEventLtd, schdBlockDate, severityLvl, travelInd, travelStartDate, travelEndDate, accounts |
| REMOVED includePrimaryMemberOnly, plastic, demographic, dateLastUsed, dateLastUpdated, dateLastMaintained, activationStatus, activationMethod, activationTime, financialInstitutionId, accountNumber, accountType, accountQualifier, oarSelectType, accountDescription, canAccountWithdraw, canAccountDeposit, canAccountInquiry, paymentsToAccount, paymentsFromAccount, transferToAccount, transferFromAccount, canAccountPurchase, thirdPartyPayments, primaryIndicator, fundingIndicator, ledgerBalance, availableBalance, creditLineAmount, lastTransactionTimestamp, accountStatus, overdraftAmount, overdraftFinancialInstitutionID, overdraftAccountNumber, overdraftAccountType |
Response POST
| V2 Response POST | V1 Response POST |
|---|---|
| NEW card, accounts, addresses: {addressFormat, addressLine1, addressLine2, addressLine3, addressLine4, addressType, beginUsageDate, city, countryCode, endUsageDate, lastAddressUpdated, postalCode, stateProvince}; members: {cardOrdFlag, cardOrdStatDate, cardOrdStatFlag, cardOrdType, cardReplInd, cardStockCode, customImageId, dateLastIssued, dateOfBirth, dateOrigIssued, emailAddress1, emailAddress2, embossedName, firstName, flatCardInd, imageId, isPrimaryContact, issuerStockCode, languageInd, lastMemberUpdated, lastName, memberNum, middleInitial, militaryEndDate, militaryFlag, militaryStartDate, motherMaidenName, passcode, phones: {firstCallInd, phoneNum, phoneType, secondCallInd} *(phone data set repeats twice); photoId, prefix, socialSecurityNumber, suffix, trackNameMatch, userValidation}; (*same data set repeated for three (3) other members); optOutVauAbuFlag, previousCards, replacedByCards, enterpriseCustomerId, pan |
SAME data, dateLastUsed, dateLastUpdated, dateLastMaintained, pinFailCount, limitGroup, canWithdraw, canDeposit, canInquire, paymentsTo, paymentsFrom, transfersTo, transfersFrom, canPurchase, thirdPartyPymt, pinOffsetIndicator, pinOffset, expirationDate, greetingName, mobileEnrollment, avsData, lastDemographicUpdated, cardStatus, prevCardStatus, lastCardStatusUpdated, activationStatus, activationMethod, activationTime, prevCardExpirationDate, prevCardActivationStatus, lastTimePinChanged, cardMediaType, serviceCode, cardProfile, autoIssueInd, cardAssociation, cardType, cardSubType, customerSince, vipInd, embossedBusiness, cardCategory, hasCardCompanionMini, hasCardCompanionMicro, hasCardCompanionMobile, contactPref, creditLimit, cashLimit, pwrOfAttrnyFlag, pwrOfAttrnyName, bankBranchNo, vruCntrCardAct, vruCntrPinChange, alrtEventNo, alrtEventDate, alrtEventLtd, schdBlockDate, severityLvl, travelInd, travelStartDate, travelEndDate, accounts |
| REMOVED demographic, financialInstitutionId, accountNumber, accountType, accountQualifier, oarSelectType, accountDescription, canAccountWithdraw, canAccountDeposit, canAccountInquiry, paymentsToAccount, paymentsFromAccount, transferToAccount, transferFromAccount, canAccountPurchase, thirdPartyPayments, primaryIndicator fundingIndicator ledgerBalance availableBalance, creditLineAmount, lastTransactionTimestamp, accountStatus, overdraftAmount, overdraftFinancialInstitutionID overdraftAccountNumber, overdraftAccountType |
/connex/card PUT
| V2 Request PUT | V1 Request PUT |
|---|---|
| NEW card, addresses: {addressFormat, addressLine1, addressLine2, addressLine3, addressLine4, addressType, beginUsageDate, city, countryCode, endUsageDate, lastAddressUpdated, postalCode, stateProvince}; avsData, bankBranchNo, canDeposit, canInquire, canPurchase, canWithdraw; members: {cardOrdFlag, cardOrdStatDate, cardOrdStatFlag, cardOrdType, cardReplInd, cardStockCode, customImageId, dateLastIssued, dateOfBirth, dateOrigIssued, emailAddress1, emailAddress2, embossedName, firstName, flatCardInd, imageId, isPrimaryContact, issuerStockCode, languageInd, lastMemberUpdated, lastName, memberNum, middleInitial, militaryEndDate, militaryFlag, militaryStartDate, motherMaidenName, passcode, phones, firstCallInd, phoneNum, phoneType, secondCallInd, photoId, prefix, socialSecurityNumber, suffix, trackNameMatch, userValidation}; (*same data set repeated for three (3) other members); optOutVauAbuFlag, previousCards, replacedByCards, enterpriseCustomerId; |
SAME pan, includeAccountDetails, dateLastUsed, dateLastUpdated, dateLastMaintained, pinFailCount, limitGroup, canWithdraw, canDeposit, canInquire, paymentsTo, paymentsFrom, transfersTo, transfersFrom, canPurchase, thirdPartyPymt, pinOffsetIndicator, pinOffset, expirationDate, greetingName, mobileEnrollment, avsData, lastDemographicUpdated, cardStatus, prevCardStatus, lastCardStatusUpdated, activationStatus, activationMethod, activationTime, prevCardExpirationDate, prevCardActivationStatus, lastTimePinChanged, cardMediaType, serviceCode, cardProfile, autoIssueInd, cardAssociation, cardType, cardSubType, customerSince, vipInd, embossedBusiness, cardCategory, hasCardCompanionMini, hasCardCompanionMicro, hasCardCompanionMobile, contactPref, creditLimit, cashLimit, pwrOfAttrnyFlag, pwrOfAttrnyName, bankBranchNo, vruCntrCardAct, vruCntrPinChange, alrtEventNo, alrtEventDate, alrtEventLtd, schdBlockDate, severityLvl, travelInd, travelStartDate, travelEndDate, accounts |
| REMOVED plastic, demographic, financialInstitutionId, accountNumber, accountType, accountQualifier, oarSelectType, accountDescription, canAccountWithdraw, canAccountDeposit, canAccountInquiry, paymentsToAccount, paymentsFromAccount, transferToAccount, transferFromAccount, canAccountPurchase, thirdPartyPayments, primaryIndicator, fundingIndicator, ledgerBalance, availableBalance, creditLineAmount, lastTransactionTimestamp, accountStatus, overdraftAmount, overdraftFinancialInstitutionID, overdraftAccountNumber, overdraftAccountType; |
Response PUT
| V2 Response PUT | V1 Response PUT |
|---|---|
| NEW card, addresses: {addressFormat, addressLine1, addressLine2, addressLine3, addressLine4, addressType, beginUsageDate, city, countryCode, endUsageDate, lastAddressUpdated, postalCode, stateProvince}; members: {cardOrdFlag, cardOrdStatDate, cardOrdStatFlag, cardOrdType, cardReplInd, cardStockCode, customImageId, dateLastIssued, dateOfBirth, dateOrigIssued, emailAddress1, emailAddress2, embossedName, firstName, flatCardInd, imageId, isPrimaryContact, issuerStockCode, languageInd, lastMemberUpdated, lastName, memberNum, middleInitial, militaryEndDate, militaryFlag, militaryStartDate, motherMaidenName, passcode, phones: {firstCallInd, phoneNum, phoneType, secondCallInd}; photoId, prefix, socialSecurityNumber, suffix, trackNameMatch, userValidation}; (*same data set repeated for three (3) other members); optOutVauAbuFlag, previousCards, replacedByCards, enterpriseCustomerId, pan; |
SAME data, dateLastUsed, dateLastUpdated, dateLastMaintained, pinFailCount, limitGroup, paymentsTo, paymentsFrom, transfersTo, transfersFrom, thirdPartyPymt, pinOffsetIndicator, pinOffset, expirationDate, greetingName, mobileEnrollment, lastDemographicUpdated, cardStatus, prevCardStatus, lastCardStatusUpdated, activationStatus, activationMethod, activationTime, prevCardExpirationDate, prevCardActivationStatus, lastTimePinChanged, cardMediaType, serviceCode, cardProfile, autoIssueInd, cardAssociation, cardType, cardSubType, customerSince, vipInd, embossedBusiness, cardCategory, hasCardCompanionMini, hasCardCompanionMicro, hasCardCompanionMobile, contactPref, creditLimit, cashLimit, pwrOfAttrnyFlag, pwrOfAttrnyName, vruCntrCardAct, vruCntrPinChange, alrtEventNo, alrtEventDate, alrtEventLtd, schdBlockDate, severityLvl, travelInd, travelStartDate, travelEndDate, accounts; |
| REMOVED demographic, canWithdraw, canDeposit, canInquire, canPurchase, avsData, bankBranchNo, financialInstitutionId, accountNumber, accountType, accountQualifier, oarSelectType, accountDescription, canAccountWithdraw, canAccountDeposit, canAccountInquiry, paymentsToAccount, paymentsFromAccount, transferToAccount, transferFromAccount, canAccountPurchase, thirdPartyPayments, primaryIndicator, fundingIndicator, ledgerBalance, availableBalance, creditLineAmount, lastTransactionTimestamp, accountStatus, overdraftAmount, overdraftFinancialInstitutionID, overdraftAccountNumber, overdraftAccountType; |